IApi.SetCycleTime method

Sets the EtherCAT cycle time.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError SetCycleTime(
       double Cycle
)

Function SetCycleTime(
       Cycle As Double
) As KsError

Parameters

Cycle

The interpolation cycle time in second.

Return value

A return code of a method.

Remarks

This method must be called after Create or CreateAsync and before Start.
The minimum cycle time is 100 microseconds, the maximum cycle time is 2 milliseconds.
To use the cycle time less than 1 millisecond, High Speed Timer Package is required.
The cycle time must be a multiple of the RTX64 HAL period.
The cycle time for individual slaves will automatically be increased if a slave cannot go that fast.
Recommended cycle times are 100 microseconds, 125 microseconds, 250 microseconds, 500 microseconds, 1 millisecond, 2 milliseconds.

Usable EtherCAT states

ecatOffline

Examples

N/A